Require gtk-doc 1.8
authorMatthias Clasen <mclasen@redhat.com>
Sun, 25 Nov 2007 06:51:19 +0000 (06:51 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Sun, 25 Nov 2007 06:51:19 +0000 (06:51 +0000)
2007-11-25  Matthias Clasen  <mclasen@redhat.com>

        * configure.in: Require gtk-doc 1.8

        * */*.c: Use gtk-doc abbreviations for examples in docs.

svn path=/trunk/; revision=19041

25 files changed:
ChangeLog
configure.in
gdk/gdk.c
gdk/gdkdisplaymanager.c
gdk/gdkevents.c
gtk/gtkaboutdialog.c
gtk/gtkcellrenderer.c
gtk/gtkdialog.c
gtk/gtkfilechooser.c
gtk/gtkfilefilter.c
gtk/gtkiconview.c
gtk/gtklabel.c
gtk/gtkliststore.c
gtk/gtkmessagedialog.c
gtk/gtknotebook.c
gtk/gtkprintoperation.c
gtk/gtkradioaction.c
gtk/gtkrc.c
gtk/gtkrecentfilter.c
gtk/gtktreeselection.c
gtk/gtktreestore.c
gtk/gtktreeviewcolumn.c
gtk/gtkuimanager.c
gtk/gtkwidget.c
gtk/gtkwindow.c

index 5ddb5b0283f6b6e59fd799e34636507d1c26c4ad..e80f2d747bcf24db86ba28a37290b1c124c0a023 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2007-11-25  Matthias Clasen  <mclasen@redhat.com>
+
+       * configure.in: Require gtk-doc 1.8
+
+       * */*.c: Use gtk-doc abbreviations for examples in docs.
+
 2007-11-25  Matthias Clasen  <mclasen@redhat.com>
 
        * gtk/gtktreeview.c (gtk_tree_view_set_show_expanders): Fix a
index 16996615d5d9d2842c9269b996ba99a78b83eff7..9c2cc9b83399b90b53decb35bb2e8155523b13ca 100644 (file)
@@ -220,7 +220,7 @@ AC_ARG_ENABLE(xkb,
 AC_ARG_ENABLE(xinerama,
               [AC_HELP_STRING([--enable-xinerama],
                              [support xinerama extension if available [default=yes]])],,
-              [enable_xinerama="yes"])
+              [enable_xinerama="no"])
 AC_ARG_ENABLE(rebuilds,
               [AC_HELP_STRING([--disable-rebuilds],
                               [disable all source autogeneration rules])],,
@@ -1639,7 +1639,7 @@ fi
 # Checks for gtk-doc and docbook-tools
 ##################################################
 
-GTK_DOC_CHECK([1.6])
+GTK_DOC_CHECK([1.8])
 
 AC_CHECK_PROG(DB2HTML, db2html, true, false)
 AM_CONDITIONAL(HAVE_DOCBOOK, $DB2HTML)
index cf14ac46585e045d817cac64f1d27034a742af81..a61543ae56bff2299de1fe002f1f2887fcbffce5 100644 (file)
--- a/gdk/gdk.c
+++ b/gdk/gdk.c
@@ -504,18 +504,18 @@ gdk_threads_dispatch_free (gpointer data)
  * running in thread A and accessing @self after it has been finalized
  * in thread B:
  *
- * <informalexample><programlisting>
+ * |[
  * static gboolean
  * idle_callback (gpointer data)
  * {
- *    // gdk_threads_enter(); would be needed for g_idle_add()
+ *    /&ast; gdk_threads_enter(); would be needed for g_idle_add() &ast;/
  *
  *    SomeWidget *self = data;
- *    /<!-- -->* do stuff with self *<!-- -->/
+ *    /&ast; do stuff with self &ast;/
  *
  *    self->idle_id = 0;
  *
- *    // gdk_threads_leave(); would be needed for g_idle_add()
+ *    /&ast; gdk_threads_leave(); would be needed for g_idle_add() &ast;/
  *    return FALSE;
  * }
  *
@@ -523,7 +523,7 @@ gdk_threads_dispatch_free (gpointer data)
  * some_widget_do_stuff_later (SomeWidget *self)
  * {
  *    self->idle_id = gdk_threads_add_idle (idle_callback, self)
- *    // using g_idle_add() here would require thread protection in the callback
+ *    /&ast; using g_idle_add() here would require thread protection in the callback &ast;/
  * }
  *
  * static void
@@ -534,7 +534,7 @@ gdk_threads_dispatch_free (gpointer data)
  *      g_source_remove (self->idle_id);
  *    G_OBJECT_CLASS (parent_class)->finalize (object);
  * }
- * </programlisting></informalexample>
+ * ]|
  *
  * Return value: the ID (greater than 0) of the event source.
  *
@@ -610,12 +610,12 @@ gdk_threads_add_idle (GSourceFunc    function,
  * This variant of g_timeout_add_full() can be thought of a MT-safe version 
  * for GTK+ widgets for the following use case:
  *
- * <informalexample><programlisting>
+ * |[
  * static gboolean timeout_callback (gpointer data)
  * {
  *    SomeWidget *self = data;
  *    
- *    /<!-- -->* do stuff with self *<!-- -->/
+ *    /&ast; do stuff with self &ast;/
  *    
  *    self->timeout_id = 0;
  *    
@@ -629,14 +629,14 @@ gdk_threads_add_idle (GSourceFunc    function,
  *  
  * static void some_widget_finalize (GObject *object)
  * {
- *    SomeWidget *self = SOME_WIDGET(object);
+ *    SomeWidget *self = SOME_WIDGET (object);
  *    
  *    if (self->timeout_id)
  *      g_source_remove (self->timeout_id);
  *    
  *    G_OBJECT_CLASS (parent_class)->finalize (object);
  * }
- * </programlisting></informalexample>
+ * ]|
  *
  * Return value: the ID (greater than 0) of the event source.
  * 
index dc98b1a28bb3773a820c452343712d01763a6d8d..77c5a0578c5a38d249e11f22cd276bce90d5efc6 100644 (file)
@@ -188,10 +188,8 @@ gdk_display_manager_get_default_display (GdkDisplayManager *display_manager)
  * gdk_display_get_default:
  *
  * Gets the default #GdkDisplay. This is a convenience
- * function for:
- * <programlisting>
- *   gdk_display_manager_get_default_display (gdk_display_manager_get ())
- * </programlisting>
+ * function for
+ * <literal>gdk_display_manager_get_default_display (gdk_display_manager_get ())</literal>.
  * 
  * Returns: a #GdkDisplay, or %NULL if there is no default
  *   display.
index 1c58aadc8934e8a087f4b1e6cfa6c631d45b415a..f81d5eb363297d816a25ba510a29465170d5a224 100644 (file)
@@ -843,14 +843,15 @@ gdk_event_get_axis (GdkEvent   *event,
  * core pointer. Coordinate extraction, processing and requesting more
  * motion events from a %GDK_MOTION_NOTIFY event usually works like this:
  *
- * <informalexample><programlisting>
- * {  // motion_event handler
+ * |[
+ * { 
+ *   /&ast; motion_event handler &ast;/
  *   x = motion_event->x;
  *   y = motion_event->y;
- *   ; // handle (x,y) motion
- *   gdk_event_request_motions (motion_event); // handles is_hint events
+ *   /&ast; handle (x,y) motion &ast;/
+ *   gdk_event_request_motions (motion_event); /&ast; handles is_hint events &ast;/
  * }
- * </programlisting></informalexample>
+ * ]|
  *
  * Since: 2.12
  **/
index 13c7fa8e16fa64211c6099db3d326e0cb46e3dfa..8af1c1b2d6aa4bc2f6115bb05d994f8e789322fe 100644 (file)
@@ -1452,9 +1452,9 @@ gtk_about_dialog_get_translator_credits (GtkAboutDialog *about)
  * of the language which is currently used in the user interface.
  * Using gettext(), a simple way to achieve that is to mark the
  * string for translation:
- * <informalexample><programlisting>
+ * |[
  *  gtk_about_dialog_set_translator_credits (about, _("translator-credits"));
- * </programlisting></informalexample>
+ * ]|
  * It is a good idea to use the customary msgid "translator-credits" for this
  * purpose, since translators will already know the purpose of that msgid, and
  * since #GtkAboutDialog will detect if "translator-credits" is untranslated
index 28d200fd8e191c7fd9ae8e023807cda43df45687..71dba709b7b278ee96dc653371844eb15fe49d89 100644 (file)
@@ -139,8 +139,7 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class)
    * continue to use the same kind of widget for editing in future
    * releases, therefore you should check the type of @editable
    * before doing any specific setup, as in the following example:
-   *
-   * <informalexample><programlisting>
+   * |[
    * static void
    * text_editing_started (GtkCellRenderer *cell,
    *                       GtkCellEditable *editable,
@@ -150,13 +149,13 @@ gtk_cell_renderer_class_init (GtkCellRendererClass *class)
    *   if (GTK_IS_ENTRY (editable)) 
    *     {
    *       GtkEntry *entry = GTK_ENTRY (editable);
-   *       <!-- -->
-   *       /<!-- -->* ... create a GtkEntryCompletion *<!-- -->/
-   *       <!-- -->
+   *       
+   *       /&ast; ... create a GtkEntryCompletion &ast;/
+   *       
    *       gtk_entry_set_completion (entry, completion);
    *     }
    * }
-   * </programlisting></informalexample>
+   * ]|
    *
    * Since: 2.6
    */
index 8760c19cafde53dbcbfeeacfdccd158fac804de3..3ad4299c9889ba30f88525149c01a2d27718db7d 100644 (file)
@@ -527,7 +527,7 @@ gtk_dialog_new_empty (const gchar     *title,
  * so the first button in the list will be the leftmost button in the dialog.
  *
  * Here's a simple example:
- * <informalexample><programlisting>
+ * |[
  *  GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
  *                                                   main_app_window,
  *                                                   GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
@@ -536,7 +536,7 @@ gtk_dialog_new_empty (const gchar     *title,
  *                                                   GTK_STOCK_CANCEL,
  *                                                   GTK_RESPONSE_REJECT,
  *                                                   NULL);
- * </programlisting></informalexample>
+ * ]|
  * 
  * Return value: a new #GtkDialog
  **/
@@ -989,19 +989,19 @@ run_destroy_handler (GtkDialog *dialog, gpointer data)
  * destroying the dialog if you wish to do so.
  *
  * Typical usage of this function might be:
- * <informalexample><programlisting>
+ * |[
  *   gint result = gtk_dialog_run (GTK_DIALOG (dialog));
  *   switch (result)
  *     {
  *       case GTK_RESPONSE_ACCEPT:
- *          do_application_specific_something (<!-- -->);
+ *          do_application_specific_something ();
  *          break;
  *       default:
- *          do_nothing_since_dialog_was_cancelled (<!-- -->);
+ *          do_nothing_since_dialog_was_cancelled ();
  *          break;
  *     }
  *   gtk_widget_destroy (dialog);
- * </programlisting></informalexample>
+ * ]|
  * 
  * Note that even though the recursive main loop gives the effect of a
  * modal dialog (it prevents the user from interacting with other 
@@ -1195,7 +1195,7 @@ gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog,
  *
  * Use this function after adding all the buttons to your dialog, as the 
  * following example shows:
- * <informalexample><programlisting>
+ * |[
  * cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
  *                                        GTK_STOCK_CANCEL,
  *                                        GTK_RESPONSE_CANCEL);
@@ -1215,7 +1215,7 @@ gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog,
  *                                          GTK_RESPONSE_CANCEL,
  *                                          GTK_RESPONSE_HELP,
  *                                          -1);
- * </programlisting></informalexample>
+ * ]|
  * 
  * Since: 2.6
  */
index 68243520b99e847caf4fac0cb887961101a31a39..dbaeba006ebd9796fc5f699229492821f3d76b8a 100644 (file)
@@ -481,26 +481,26 @@ gtk_file_chooser_get_filename (GtkFileChooser *chooser)
  * Note that the file must exist, or nothing will be done except
  * for the directory change.
  *
- * If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog, you
- * should use this function if you already have a file name to which the user may save; for example,
- * when the user opens an existing file and then does <guimenuitem>File/Save As...</guimenuitem>
- * on it.  If you don't have a file name already &mdash; for example, if the user just created
- * a new file and is saving it for the first time, do not call this function.  Instead, use
- * something similar to this:
- *
- * <programlisting>
+ * If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog,
+ * you should use this function if you already have a file name to which the 
+ * user may save; for example, when the user opens an existing file and then 
+ * does <guimenuitem>File/Save As...</guimenuitem> on it.  If you don't have 
+ * a file name already &mdash; for example, if the user just created a new 
+ * file and is saving it for the first time, do not call this function.  
+ * Instead, use something similar to this:
+ * |[
  * if (document_is_new)
  *   {
- *     /<!-- -->* the user just created a new document *<!-- -->/
+ *     /&ast; the user just created a new document &ast;/
  *     gtk_file_chooser_set_current_folder (chooser, default_folder_for_saving);
  *     gtk_file_chooser_set_current_name (chooser, "Untitled document");
  *   }
  * else
  *   {
- *     /<!-- -->* the user edited an existing document *<!-- -->
+ *     /&ast; the user edited an existing document &ast;
  *     gtk_file_chooser_set_filename (chooser, existing_filename);
  *   }
- * </programlisting>
+ * ]|
  * 
  * Return value: %TRUE if both the folder could be changed and the file was
  * selected successfully, %FALSE otherwise.
@@ -805,28 +805,28 @@ gtk_file_chooser_get_uri (GtkFileChooser *chooser)
  * to a sequence of gtk_file_chooser_unselect_all() followed by
  * gtk_file_chooser_select_uri().
  *
- * Note that the URI must exist, or nothing will be done except
- * for the directory change.
- * If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog, you
- * should use this function if you already have a file name to which the user may save; for example,
- * when the user opens an existing file and then does <guimenuitem>File/Save As...</guimenuitem>
- * on it.  If you don't have a file name already &mdash; for example, if the user just created
- * a new file and is saving it for the first time, do not call this function.  Instead, use
- * something similar to this:
- *
- * <programlisting>
+ * Note that the URI must exist, or nothing will be done except for the 
+ * directory change.
+ * If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog,
+ * you should use this function if you already have a file name to which the 
+ * user may save; for example, when the user opens an existing file and then 
+ * does <guimenuitem>File/Save As...</guimenuitem> on it.  If you don't have 
+ * a file name already &mdash; for example, if the user just created a new 
+ * file and is saving it for the first time, do not call this function.  
+ * Instead, use something similar to this:
+ * |[
  * if (document_is_new)
  *   {
- *     /<!-- -->* the user just created a new document *<!-- -->/
+ *     /&ast; the user just created a new document &ast;/
  *     gtk_file_chooser_set_current_folder_uri (chooser, default_folder_for_saving);
  *     gtk_file_chooser_set_current_name (chooser, "Untitled document");
  *   }
  * else
  *   {
- *     /<!-- -->* the user edited an existing document *<!-- -->
+ *     /&ast; the user edited an existing document &ast;
  *     gtk_file_chooser_set_uri (chooser, existing_uri);
  *   }
- * </programlisting>
+ * ]|
  *
  * Return value: %TRUE if both the folder could be changed and the URI was
  * selected successfully, %FALSE otherwise.
index 2c7f6fee704e711cdaa751055562349ec0138c75..992de08a0dd81347deb45f25362f23aac08bbbbe 100644 (file)
@@ -144,11 +144,10 @@ gtk_file_filter_finalize (GObject  *object)
  * gtk_file_filter_add_mime_type(), gtk_file_filter_add_pattern(),
  * or gtk_file_filter_add_custom(). To create a filter
  * that accepts any file, use:
- *
- * <informalexample><programlisting>
- * GtkFileFilter *filter = gtk_file_filter_new (<!-- -->);
+ * |[
+ * GtkFileFilter *filter = gtk_file_filter_new ();
  * gtk_file_filter_add_pattern (filter, "*");
- * </programlisting></informalexample>
+ * ]|
  * 
  * Return value: a new #GtkFileFilter
  * 
index f5e14e506cf2d610f75c01df19e76719f8156ee2..fd34c094ca09a35087139566f6083c4583367229 100644 (file)
@@ -5592,10 +5592,10 @@ gtk_icon_view_unselect_path (GtkIconView *icon_view,
  * To do this, you can use gtk_tree_row_reference_new().
  *
  * To free the return value, use:
- * <informalexample><programlisting>
+ * |[
  * g_list_foreach (list, gtk_tree_path_free, NULL);
  * g_list_free (list);
- * </programlisting></informalexample>
+ * ]|
  *
  * Return value: A #GList containing a #GtkTreePath for each selected row.
  *
index 09fcb85a758f691940f47bc836b7f26c60f74c56..cd6c5acfd22184a941ef2ad6d637414eee34a8f3 100644 (file)
@@ -1412,13 +1412,13 @@ set_markup (GtkLabel    *label,
  * label's text and attribute list based on the parse results. If the @str is
  * external data, you may need to escape it with g_markup_escape_text() or
  * g_markup_printf_escaped()<!-- -->:
- * <informalexample><programlisting>
+ * |[
  * char *markup;
- * <!-- -->
+ * 
  * markup = g_markup_printf_escaped ("&lt;span style=\"italic\"&gt;&percnt;s&lt;/span&gt;", str);
  * gtk_label_set_markup (GTK_LABEL (label), markup);
  * g_free (markup);
- * </programlisting></informalexample>
+ * ]|
  **/
 void
 gtk_label_set_markup (GtkLabel    *label,
index 617a5fedd8adaeb76a9e7c567d19ed10eb4bccf6..3557a7cf36cbd013717c7bfa41d7cf056ff47375 100644 (file)
@@ -1890,10 +1890,10 @@ gtk_list_store_has_default_sort_func (GtkTreeSortable *sortable)
  * Calling
  * <literal>gtk_list_store_insert_with_values(list_store, iter, position...)</literal> 
  * has the same effect as calling 
- * <informalexample><programlisting>
+ * |[
  * gtk_list_store_insert (list_store, iter, position);
  * gtk_list_store_set (list_store, iter, ...);
- * </programlisting></informalexample>
+ * ]|
  * with the difference that the former will only emit a row_inserted signal,
  * while the latter will emit row_inserted, row_changed and, if the list store
  * is sorted, rows_reordered. Since emitting the rows_reordered signal
index c67277ebafeeb1b29791f550175e4d64d836cb8a..fe1a5c0d7b44e9a26afff3b0a2f9c59703abaf03 100644 (file)
@@ -566,8 +566,7 @@ gtk_message_dialog_new (GtkWindow     *parent,
  * instead, since you can't pass the markup string either
  * as the format (it might contain '%' characters) or as a string
  * argument.
- *
- * <informalexample><programlisting>
+ * |[
  *  GtkWidget *dialog;
  *  dialog = gtk_message_dialog_new (main_application_window,
  *                                   GTK_DIALOG_DESTROY_WITH_PARENT,
@@ -576,7 +575,7 @@ gtk_message_dialog_new (GtkWindow     *parent,
  *                                   NULL);
  *  gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog),
  *                                 markup);
- * </programlisting></informalexample>
+ * ]|
  * 
  * Return value: a new #GtkMessageDialog
  *
index 4389da32b17117257feb78de136cc80a2172ec7f..eb201c5768de6419f2301fbd9c46b2036120ba60 100644 (file)
@@ -7508,8 +7508,7 @@ gtk_notebook_get_tab_detachable (GtkNotebook *notebook,
  * destination and accept the target "GTK_NOTEBOOK_TAB". The notebook
  * will fill the selection with a GtkWidget** pointing to the child
  * widget that corresponds to the dropped tab.
- *
- * <informalexample><programlisting>
+ * |[
  *  static void
  *  on_drop_zone_drag_data_received (GtkWidget        *widget,
  *                                   GdkDragContext   *context,
@@ -7529,7 +7528,7 @@ gtk_notebook_get_tab_detachable (GtkNotebook *notebook,
  *    process_widget (*child);
  *    gtk_container_remove (GTK_CONTAINER (notebook), *child);
  *  }
- * </programlisting></informalexample>
+ * ]|
  *
  * If you want a notebook to accept drags from other widgets,
  * you will have to set your own DnD code to do it.
index 5d2740f5a65437f2d0111501fce6bf96c8306901..d08f2550674d9a6ad66b83c5235ae3e9811f8dea 100644 (file)
@@ -667,8 +667,7 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class)
    * Emitted for every page that is printed. The signal handler
    * must render the @page_nr's page onto the cairo context obtained
    * from @context using gtk_print_context_get_cairo_context().
-   *
-   * <informalexample><programlisting>
+   * |[
    * static void
    * draw_page (GtkPrintOperation *operation,
    *            GtkPrintContext   *context,
@@ -699,7 +698,7 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class)
    *   pango_layout_set_width (layout, width * PANGO_SCALE);
    *   pango_layout_set_alignment (layout, PANGO_ALIGN_CENTER);
    *                         
-   *   pango_layout_get_size (layout, NULL, &amp;layout_height);
+   *   pango_layout_get_size (layout, NULL, &layout_height);
    *   text_height = (gdouble)layout_height / PANGO_SCALE;
    *   
    *   cairo_move_to (cr, width / 2,  (HEADER_HEIGHT - text_height) / 2);
@@ -707,7 +706,7 @@ gtk_print_operation_class_init (GtkPrintOperationClass *class)
    *   
    *   g_object_unref (layout);
    * }
-   * </programlisting></informalexample>
+   * ]|
    *
    * Use gtk_print_operation_set_use_full_page() and 
    * gtk_print_operation_set_unit() before starting the print operation
@@ -2349,8 +2348,7 @@ gtk_print_operation_get_error (GtkPrintOperation  *op,
  * platform. The #GtkPrintOperation::done signal will be emitted with the 
  * operation results when the operation is done (i.e. when the dialog is 
  * canceled, or when the print succeeds or fails).
- *
- * <informalexample><programlisting>
+ * |[
  * if (settings != NULL)
  *   gtk_print_operation_set_print_settings (print, settings);
  *   
@@ -2358,11 +2356,14 @@ gtk_print_operation_get_error (GtkPrintOperation  *op,
  *   gtk_print_operation_set_default_page_setup (print, page_setup);
  *   
  * g_signal_connect (print, "begin-print", 
- *                   G_CALLBACK (begin_print), &amp;data);
+ *                   G_CALLBACK (begin_print), &data);
  * g_signal_connect (print, "draw-page", 
- *                   G_CALLBACK (draw_page), &amp;data);
+ *                   G_CALLBACK (draw_page), &data);
  *  
- * res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG, parent, &amp;error);
+ * res = gtk_print_operation_run (print, 
+ *                                GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG, 
+ *                                parent, 
+ *                                &error);
  *  
  * if (res == GTK_PRINT_OPERATION_RESULT_ERROR)
  *  {
@@ -2370,7 +2371,7 @@ gtk_print_operation_get_error (GtkPrintOperation  *op,
  *                                          GTK_DIALOG_DESTROY_WITH_PARENT,
  *                                          GTK_MESSAGE_ERROR,
  *                                          GTK_BUTTONS_CLOSE,
- *                                          "Error printing file:\n&percnt;s",
+ *                                          "Error printing file:\n%s",
  *                                          error->message);
  *    g_signal_connect (error_dialog, "response", 
  *                      G_CALLBACK (gtk_widget_destroy), NULL);
@@ -2383,7 +2384,7 @@ gtk_print_operation_get_error (GtkPrintOperation  *op,
  *     g_object_unref (settings);
  *    settings = g_object_ref (gtk_print_operation_get_print_settings (print));
  *  }
- * </programlisting></informalexample>
+ * ]|
  *
  * Note that gtk_print_operation_run() can only be called once on a
  * given #GtkPrintOperation.
index b2c8adee769d9ccd5c2f66f45f67acaea028781b..772dd8c57cb4bb98c67701c00aec5f3971b17d18 100644 (file)
@@ -377,18 +377,18 @@ create_menu_item (GtkAction *action)
  * to the group. 
  *
  * A common way to set up a group of radio group is the following:
- * <informalexample><programlisting>
+ * |[
  *   GSList *group = NULL;
  *   GtkRadioAction *action;
  *  
- *   while (/<!-- -->* more actions to add *<!-- -->/)
+ *   while (/&ast; more actions to add &ast;/)
  *     {
  *        action = gtk_radio_action_new (...);
  *        
  *        gtk_radio_action_set_group (action, group);
  *        group = gtk_radio_action_get_group (action);
  *     }
- * </programlisting></informalexample>
+ * ]|
  *
  * Returns: the list representing the radio group for this object
  *
index 2100e00c7c61699906d47ef36e8f1e01f8531cff..8c1145504b09c0dfa7a6f39a380bf00af896ef27 100644 (file)
@@ -2034,12 +2034,13 @@ gtk_rc_get_style (GtkWidget *widget)
  * would be items inside a GNOME canvas widget.
  *
  * The action of gtk_rc_get_style() is similar to:
- * <informalexample><programlisting>
- *  gtk_widget_path (widget, NULL, &amp;path, NULL);
- *  gtk_widget_class_path (widget, NULL, &amp;class_path, NULL);
- *  gtk_rc_get_style_by_paths (gtk_widget_get_settings (widget), path, class_path,
+ * |[
+ *  gtk_widget_path (widget, NULL, &path, NULL);
+ *  gtk_widget_class_path (widget, NULL, &class_path, NULL);
+ *  gtk_rc_get_style_by_paths (gtk_widget_get_settings (widget), 
+ *                             path, class_path,
  *                             G_OBJECT_TYPE (widget));
- * </programlisting></informalexample>
+ * ]|
  * 
  * Return value: A style created by matching with the supplied paths,
  *   or %NULL if nothing matching was specified and the default style should
index a37104254235870f85cd680441f465919c314454..f5dbe8ef7e7459429ef28960a9dddb59bc3aa797 100644 (file)
@@ -168,11 +168,10 @@ gtk_recent_filter_init (GtkRecentFilter *filter)
  * gtk_recent_filter_add_pattern(), gtk_recent_filter_add_mime_type(),
  * gtk_recent_filter_add_application(), gtk_recent_filter_add_age().
  * To create a filter that accepts any recently used resource, use:
- *
- * <informalexample><programlisting>
- * GtkRecentFilter *filter = gtk_recent_filter_new (<!-- -->);
+ * |[
+ * GtkRecentFilter *filter = gtk_recent_filter_new ();
  * gtk_recent_filter_add_pattern (filter, "*");
- * </programlisting></informalexample>
+ * ]|
  *
  * Return value: a new #GtkRecentFilter
  *
index d5aad37c8b1253ac71f5f6f59e849903a2fc8b6e..75889851c60c32ce8c326cce1be1dcaa1ec7cacf 100644 (file)
@@ -392,10 +392,10 @@ gtk_tree_selection_get_selected (GtkTreeSelection  *selection,
  * To do this, you can use gtk_tree_row_reference_new().
  *
  * To free the return value, use:
- * <informalexample><programlisting>
+ * |[
  * g_list_foreach (list, gtk_tree_path_free, NULL);
  * g_list_free (list);
- * </programlisting></informalexample>
+ * ]|
  *
  * Return value: A #GList containing a #GtkTreePath for each selected row.
  *
index ecc42715471b0f2022ddfdbd6c2b295e636f1d9d..928926aa7e7d2ef3d791a145685a877f354cf342 100644 (file)
@@ -1388,10 +1388,10 @@ gtk_tree_store_insert_after (GtkTreeStore *tree_store,
  * Calling
  * <literal>gtk_tree_store_insert_with_values (tree_store, iter, position, ...)</literal>
  * has the same effect as calling
- * <informalexample><programlisting>
+ * |[
  * gtk_tree_store_insert (tree_store, iter, position);
  * gtk_tree_store_set (tree_store, iter, ...);
- * </programlisting></informalexample>
+ * ]|
  * with the different that the former will only emit a row_inserted signal,
  * while the latter will emit row_inserted, row_changed and if the tree store
  * is sorted, rows_reordered.  Since emitting the rows_reordered signal
index ea8adbb813eae4db8628eaccc15b3453760de94f..d3824c830c23d7eef498de0597a6cd51e091ee06 100644 (file)
@@ -1444,12 +1444,12 @@ gtk_tree_view_column_new (void)
  * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
  *
  * Here's a simple example:
- * <informalexample><programlisting>
+ * |[
  *  enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
  *  ...
  *  {
  *    GtkTreeViewColumn *column;
- *    GtkCellRenderer   *renderer = gtk_cell_renderer_text_new (<!-- -->);
+ *    GtkCellRenderer   *renderer = gtk_cell_renderer_text_new ();
  *  
  *    column = gtk_tree_view_column_new_with_attributes ("Title",
  *                                                       renderer,
@@ -1457,7 +1457,7 @@ gtk_tree_view_column_new (void)
  *                                                       "foreground", COLOR_COLUMN,
  *                                                       NULL);
  *  }
- * </programlisting></informalexample>
+ * ]|
  * 
  * Return value: A newly created #GtkTreeViewColumn.
  **/
index 95aa71da67077099670f5c669c292bbe41f1d676..9528bc41f54bcce7d4c129d97e370a2aa4888ac8 100644 (file)
@@ -2782,8 +2782,7 @@ queue_update (GtkUIManager *self)
  * UI in an idle function. A typical example where this function is
  * useful is to enforce that the menubar and toolbar have been added to 
  * the main window before showing it:
- * <informalexample>
- * <programlisting>
+ * |[
  * gtk_container_add (GTK_CONTAINER (window), vbox); 
  * g_signal_connect (merge, "add_widget", 
  *                   G_CALLBACK (add_widget), vbox);
@@ -2791,8 +2790,7 @@ queue_update (GtkUIManager *self)
  * gtk_ui_manager_add_ui_from_file (merge, "my-toolbars");
  * gtk_ui_manager_ensure_update (merge);  
  * gtk_widget_show (window);
- * </programlisting>
- * </informalexample>
+ * ]|
  *
  * Since: 2.4
  **/
index 27e4db5281d9b51ab245828eb4ff3179e46296c5..ca8d968f7dd7be83f0bb87c381a7c9c74b965bb9 100644 (file)
@@ -1675,8 +1675,7 @@ gtk_widget_class_init (GtkWidgetClass *klass)
    * #GtkWidget::drag-leave and if not, treat the drag-motion signal as an 
    * "enter" signal. Upon an "enter", the handler will typically highlight 
    * the drop site with gtk_drag_highlight().
-   *
-   * <informalexample><programlisting> 
+   * |[
    * static void
    * drag_motion (GtkWidget *widget,
    *             GdkDragContext *context,
@@ -1721,11 +1720,11 @@ gtk_widget_class_init (GtkWidgetClass *klass)
    *    {
    *      private_data->suggested_action = 0;
    *      
-   *     /<!-- -->* We are getting this data due to a request in drag_motion,
+   *     /&ast; We are getting this data due to a request in drag_motion,
    *      * rather than due to a request in drag_drop, so we are just
-   *      * supposed to call gdk_drag_status(<!-- -->), not actually paste in 
+   *      * supposed to call gdk_drag_status (), not actually paste in 
    *      * the data.
-   *      *<!-- -->/
+   *      &ast;/
    *      str = gtk_selection_data_get_text (selection_data);
    *      if (!data_is_acceptable (str)) 
    *        gdk_drag_status (context, 0, time);
@@ -1734,10 +1733,10 @@ gtk_widget_class_init (GtkWidgetClass *klass)
    *    }
    *   else
    *    {
-   *      /<!-- -->* accept the drop *<!-- -->/
+   *      /&ast; accept the drop &ast;/
    *    }
    * }
-   * </programlisting></informalexample>
+   * ]|
    */
   widget_signals[DRAG_MOTION] =
     g_signal_new (I_("drag_motion"),
@@ -1837,7 +1836,7 @@ gtk_widget_class_init (GtkWidgetClass *klass)
    * The handler may inspect and modify @drag_context->action before calling 
    * gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as shown in the 
    * following example:
-   * <informalexample><programlisting>
+   * |[
    * void  
    * drag_data_received (GtkWidget          *widget,
    *                     GdkDragContext     *drag_context,
@@ -1875,7 +1874,7 @@ gtk_widget_class_init (GtkWidgetClass *klass)
    *       
    *    gtk_drag_finish (drag_context, FALSE, FALSE, time);
    *  }
-   * </programlisting></informalexample>
+   * ]|
    */
   widget_signals[DRAG_DATA_RECEIVED] =
     g_signal_new (I_("drag_data_received"),
@@ -5317,11 +5316,11 @@ gtk_widget_set_state (GtkWidget           *widget,
  * Note that the background is still drawn when the widget is mapped.
  * If this is not suitable (e.g. because you want to make a transparent
  * window using an RGBA visual), you can work around this by doing:
- * <informalexample><programlisting>
+ * |[
  *  gtk_widget_realize (window);
  *  gdk_window_set_back_pixmap (window->window, NULL, FALSE);
  *  gtk_widget_show (window);
- * </programlisting></informalexample> 
+ * ]|
  **/
 void
 gtk_widget_set_app_paintable (GtkWidget *widget,
@@ -7264,13 +7263,13 @@ gtk_widget_set_extension_events (GtkWidget *widget,
  * To reliably find the toplevel #GtkWindow, use
  * gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
  * is set on the result.
- * <informalexample><programlisting>
+ * |[
  *  GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
  *  if (GTK_WIDGET_TOPLEVEL (toplevel))
  *    {
- *      [ Perform action on toplevel. ]
+ *      /&ast; Perform action on toplevel. &ast;/
  *    }
- * </programlisting></informalexample>
+ * ]|
  *
  * Return value: the topmost ancestor of @widget, or @widget itself 
  *    if there's no ancestor.
@@ -7593,15 +7592,15 @@ gtk_widget_get_composite_name (GtkWidget *widget)
  * builders might want to treat them in a different way.
  * 
  * Here is a simple example:
- * <informalexample><programlisting>
- *   gtk_widget_push_composite_child (<!-- -->);
+ * |[
+ *   gtk_widget_push_composite_child ();
  *   scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
  *   gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
- *   gtk_widget_pop_composite_child (<!-- -->);
+ *   gtk_widget_pop_composite_child ();
  *   gtk_widget_set_parent (scrolled_window->hscrollbar, 
  *                          GTK_WIDGET (scrolled_window));
  *   g_object_ref (scrolled_window->hscrollbar);
- * </programlisting></informalexample>
+ * ]|
  **/
 void
 gtk_widget_push_composite_child (void)
index 78b34011c6c840d6b7defdca1326e8bdf2bcbf4e..43d19d1a55b209be4acd9e96012cf02a09a663f7 100644 (file)
@@ -7663,14 +7663,13 @@ gtk_XParseGeometry (const char   *string,
  * to be called when the window has its "final" size, i.e. after calling
  * gtk_widget_show_all() on the contents and gtk_window_set_geometry_hints()
  * on the window.
- * 
- * <informalexample><programlisting>
- * #include &lt;gtk/gtk.h&gt;
+ * |[
+ * #include <gtk/gtk.h>
  *    
  * static void
  * fill_with_content (GtkWidget *vbox)
  * {
- *   /<!-- -->* fill with content... *<!-- -->/
+ *   /&ast; fill with content... &ast;/
  * }
  *    
  * int
@@ -7681,7 +7680,7 @@ gtk_XParseGeometry (const char   *string,
  *     100, 50, 0, 0, 100, 50, 10, 10, 0.0, 0.0, GDK_GRAVITY_NORTH_WEST  
  *   };
  *    
- *   gtk_init (&amp;argc, &amp;argv);
+ *   gtk_init (&argc, &argv);
  *   
  *   window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
  *   vbox = gtk_vbox_new (FALSE, 0);
@@ -7692,7 +7691,7 @@ gtk_XParseGeometry (const char   *string,
  *   
  *   gtk_window_set_geometry_hints (GTK_WINDOW (window),
  *                                 window,
- *                                 &amp;size_hints,
+ *                                 &size_hints,
  *                                 GDK_HINT_MIN_SIZE | 
  *                                 GDK_HINT_BASE_SIZE | 
  *                                 GDK_HINT_RESIZE_INC);
@@ -7700,7 +7699,7 @@ gtk_XParseGeometry (const char   *string,
  *   if (argc &gt; 1)
  *     {
  *       if (!gtk_window_parse_geometry (GTK_WINDOW (window), argv[1]))
- *         fprintf (stderr, "Failed to parse '&percnt;s'\n", argv[1]);
+ *         fprintf (stderr, "Failed to parse '%s'\n", argv[1]);
  *     }
  *    
  *   gtk_widget_show_all (window);
@@ -7708,7 +7707,7 @@ gtk_XParseGeometry (const char   *string,
  *    
  *   return 0;
  * }
- * </programlisting></informalexample>
+ * ]|
  *
  * Return value: %TRUE if string was parsed successfully
  **/